Node / meshtastic / Meshtastic-Android / files / core / model / src / commonMain / kotlin / org / meshtastic / core / model / util / Extensions.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tf0883e@fileTb4b4b4:Te6edf3SuppressTb4b4b4(Ta5d6ff"Ta5d6ffTooManyFunctionsTa5d6ff"Tb4b4b4)

Tff7b72package T7ee787org.meshtastic.core.model.util

Tff7b72import T7ee787org.meshtastic.proto.Channel

Tff7b72import T7ee787org.meshtastic.proto.Config

Tff7b72import T7ee787org.meshtastic.proto.MeshPacket

Tff7b72import T7ee787org.meshtastic.proto.ModuleConfig

Tff7b72import T7ee787org.meshtastic.proto.MyNodeInfo

Tff7b72import T7ee787org.meshtastic.proto.Telemetry

T8b949e/**

* When printing strings to logs sometimes we want to print useful debugging information about users or positions. But

* we don't want to leak things like usernames or locations. So this function if given a string, will return a string

* which is a maximum of three characters long, taken from the tail of the string. Which should effectively hide real

* usernames and locations, but still let us see if values were zero, empty or different.

*/

Tff7b72val Te6edf3AnyTff7b72?.Te6edf3anonymizeTb4b4b4: Tffa657String

Tff7b72getTb4b4b4(Tb4b4b4) Tff7b72= Tff7b72thisTb4b4b4.Te6edf3anonymizeTb4b4b4(Tb4b4b4)

T8b949e/** A version of anonymize that allows passing in a custom minimum length */

Tff7b72fun Td2a8ffAnyTff7b72?.Te6edf3anonymizeTb4b4b4(Te6edf3maxLenTb4b4b4: Tffa657Int Tff7b72= T79c0ff3Tb4b4b4) Tff7b72= Tff7b72if Tb4b4b4(Tff7b72this Tff7b72!Tff7b72= Tff7b72nullTb4b4b4) Ta5d6ff"Ta5d6ff...Tffd700${Tff7b72thisTb4b4b4.Te6edf3toStringTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3takeLastTb4b4b4(Te6edf3maxLenTb4b4b4)Tffd700}Ta5d6ff" Tff7b72else Ta5d6ff"Ta5d6ffnullTa5d6ff"

T8b949e// A toString that makes sure all newlines are removed (for nice logging).

Tff7b72fun Te6edf3AnyTb4b4b4.Td2a8fftoOneLineStringTb4b4b4(Tb4b4b4) Tff7b72= Tff7b72thisTb4b4b4.Te6edf3toStringTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3replaceTb4b4b4(Ta5d6ff'\n'Tb4b4b4, Ta5d6ff' 'Tb4b4b4)

Tff7b72fun Te6edf3ConfigTb4b4b4.Td2a8fftoOneLineStringTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657String Tb4b4b4{

T8b949e// Wire toString uses field=value format

Tff7b72val Te6edf3redactedFields Tff7b72= Ta5d6ff"""Ta5d6ff(wifi_psk|public_key|private_key|admin_key)=[^,}]+Ta5d6ff"""

Tff7b72return Tff7b72thisTb4b4b4.Te6edf3toStringTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3replaceTb4b4b4(Te6edf3redactedFieldsTb4b4b4.Te6edf3toRegexTb4b4b4(Tb4b4b4)Tb4b4b4) Tb4b4b4{ Ta5d6ff"Tffd700${Tffa657itTb4b4b4.Te6edf3groupValuesTff7b72[T79c0ff1Tff7b72]Tffd700}Ta5d6ff=[REDACTED]Ta5d6ff" Tb4b4b4}Tb4b4b4.Te6edf3replaceTb4b4b4(Ta5d6ff'\n'Tb4b4b4, Ta5d6ff' 'Tb4b4b4)

Tb4b4b4}

Tff7b72fun Te6edf3MeshPacketTb4b4b4.Td2a8fftoOneLineStringTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657String Tb4b4b4{

Tff7b72val Te6edf3redactedFields Tff7b72= Ta5d6ff"""Ta5d6ff(public_key|private_key|admin_key)=[^,}]+Ta5d6ff""" T8b949e// Redact keys

Tff7b72return Tff7b72thisTb4b4b4.Te6edf3toStringTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3replaceTb4b4b4(Te6edf3redactedFieldsTb4b4b4.Te6edf3toRegexTb4b4b4(Tb4b4b4)Tb4b4b4) Tb4b4b4{ Ta5d6ff"Tffd700${Tffa657itTb4b4b4.Te6edf3groupValuesTff7b72[T79c0ff1Tff7b72]Tffd700}Ta5d6ff=[REDACTED]Ta5d6ff" Tb4b4b4}Tb4b4b4.Te6edf3replaceTb4b4b4(Ta5d6ff'\n'Tb4b4b4, Ta5d6ff' 'Tb4b4b4)

Tb4b4b4}

Tff7b72fun Te6edf3ChannelTb4b4b4.Td2a8fftoOneLineStringTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657String Tb4b4b4{

T8b949e// Redact the channel preshared key (psk) from logs.

Tff7b72val Te6edf3redactedFields Tff7b72= Ta5d6ff"""Ta5d6ff(psk)=[^,}]+Ta5d6ff"""

Tff7b72return Tff7b72thisTb4b4b4.Te6edf3toStringTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3replaceTb4b4b4(Te6edf3redactedFieldsTb4b4b4.Te6edf3toRegexTb4b4b4(Tb4b4b4)Tb4b4b4) Tb4b4b4{ Ta5d6ff"Tffd700${Tffa657itTb4b4b4.Te6edf3groupValuesTff7b72[T79c0ff1Tff7b72]Tffd700}Ta5d6ff=[REDACTED]Ta5d6ff" Tb4b4b4}Tb4b4b4.Te6edf3replaceTb4b4b4(Ta5d6ff'\n'Tb4b4b4, Ta5d6ff' 'Tb4b4b4)

Tb4b4b4}

Tff7b72fun Te6edf3ModuleConfigTb4b4b4.Td2a8fftoOneLineStringTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657String Tb4b4b4{

T8b949e// Redact MQTT credentials from logs.

Tff7b72val Te6edf3redactedFields Tff7b72= Ta5d6ff"""Ta5d6ff(password|username)=[^,}]+Ta5d6ff"""

Tff7b72return Tff7b72thisTb4b4b4.Te6edf3toStringTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3replaceTb4b4b4(Te6edf3redactedFieldsTb4b4b4.Te6edf3toRegexTb4b4b4(Tb4b4b4)Tb4b4b4) Tb4b4b4{ Ta5d6ff"Tffd700${Tffa657itTb4b4b4.Te6edf3groupValuesTff7b72[T79c0ff1Tff7b72]Tffd700}Ta5d6ff=[REDACTED]Ta5d6ff" Tb4b4b4}Tb4b4b4.Te6edf3replaceTb4b4b4(Ta5d6ff'\n'Tb4b4b4, Ta5d6ff' 'Tb4b4b4)

Tb4b4b4}

Tff7b72fun Te6edf3MyNodeInfoTb4b4b4.Td2a8fftoOneLineStringTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657String Tb4b4b4{

T8b949e// Redact the hardware unique identifier from logs.

Tff7b72val Te6edf3redactedFields Tff7b72= Ta5d6ff"""Ta5d6ff(device_id)=[^,}]+Ta5d6ff"""

Tff7b72return Tff7b72thisTb4b4b4.Te6edf3toStringTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3replaceTb4b4b4(Te6edf3redactedFieldsTb4b4b4.Te6edf3toRegexTb4b4b4(Tb4b4b4)Tb4b4b4) Tb4b4b4{ Ta5d6ff"Tffd700${Tffa657itTb4b4b4.Te6edf3groupValuesTff7b72[T79c0ff1Tff7b72]Tffd700}Ta5d6ff=[REDACTED]Ta5d6ff" Tb4b4b4}Tb4b4b4.Te6edf3replaceTb4b4b4(Ta5d6ff'\n'Tb4b4b4, Ta5d6ff' 'Tb4b4b4)

Tb4b4b4}

Tff7b72fun Te6edf3AnyTb4b4b4.Td2a8fftoPIIStringTb4b4b4(Tb4b4b4) Tff7b72= Tff7b72if Tb4b4b4(Tff7b72!Te6edf3isDebugTb4b4b4) Tb4b4b4{

Ta5d6ff"Ta5d6ff<PII?>Ta5d6ff"

Tb4b4b4} Tff7b72else Tb4b4b4{

Tff7b72thisTb4b4b4.Te6edf3toOneLineStringTb4b4b4(Tb4b4b4)

Tb4b4b4}

Tf0883e@SuppressTb4b4b4(Ta5d6ff"Ta5d6ffMagicNumberTa5d6ff"Tb4b4b4)

Tff7b72fun Te6edf3ByteArrayTb4b4b4.Td2a8fftoHexStringTb4b4b4(Tb4b4b4) Tff7b72= Te6edf3joinToStringTb4b4b4(Ta5d6ff"Ta5d6ff"Tb4b4b4) Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3toUByteTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3toStringTb4b4b4(T79c0ff1T79c0ff6Tb4b4b4)Tb4b4b4.Te6edf3padStartTb4b4b4(T79c0ff2Tb4b4b4, Ta5d6ff'0'Tb4b4b4) Tb4b4b4}

Tff7b72private Tff7b72const Tff7b72val Te6edf3MPS_TO_KMPH Tff7b72= T79c0ff3.6f

Tff7b72private Tff7b72const Tff7b72val Te6edf3KM_TO_MILES Tff7b72= T79c0ff0.621371f

Tff7b72fun Te6edf3IntTb4b4b4.Td2a8ffmpsToKmphTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657Float Tb4b4b4{

T8b949e// Convert meters per second to kilometers per hour

Tff7b72val Te6edf3kmph Tff7b72= Tff7b72this Tff7b72* Te6edf3MPS_TO_KMPH

Tff7b72return Te6edf3kmph

Tb4b4b4}

Tff7b72fun Te6edf3IntTb4b4b4.Td2a8ffmpsToMphTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657Float Tb4b4b4{

T8b949e// Convert meters per second to miles per hour

Tff7b72val Te6edf3mph Tff7b72= Tff7b72this Tff7b72* Te6edf3MPS_TO_KMPH Tff7b72* Te6edf3KM_TO_MILES

Tff7b72return Te6edf3mph

Tb4b4b4}

T8b949e/** Returns true if this packet arrived via a LoRa transport mechanism. */

Tff7b72fun Te6edf3MeshPacketTb4b4b4.Td2a8ffisLoraTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657Boolean Tff7b72= Te6edf3transport_mechanism Tff7b72=Tff7b72= Te6edf3MeshPacketTb4b4b4.Te6edf3TransportMechanismTb4b4b4.Te6edf3TRANSPORT_LORA Tff7b72|Tff7b72|

Te6edf3transport_mechanism Tff7b72=Tff7b72= Te6edf3MeshPacketTb4b4b4.Te6edf3TransportMechanismTb4b4b4.Te6edf3TRANSPORT_LORA_ALT1 Tff7b72|Tff7b72|

Te6edf3transport_mechanism Tff7b72=Tff7b72= Te6edf3MeshPacketTb4b4b4.Te6edf3TransportMechanismTb4b4b4.Te6edf3TRANSPORT_LORA_ALT2 Tff7b72|Tff7b72|

Te6edf3transport_mechanism Tff7b72=Tff7b72= Te6edf3MeshPacketTb4b4b4.Te6edf3TransportMechanismTb4b4b4.Te6edf3TRANSPORT_LORA_ALT3

T8b949e/** Returns true if this packet is a direct LoRa signal (not MQTT, and hop count matches). */

Tff7b72fun Te6edf3MeshPacketTb4b4b4.Td2a8ffisDirectSignalTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657Boolean Tff7b72= Te6edf3rx_time Tff7b72> T79c0ff0 Tff7b72&Tff7b72& Te6edf3hop_start Tff7b72=Tff7b72= Te6edf3hop_limit Tff7b72&Tff7b72& Te6edf3via_mqtt Tff7b72!Tff7b72= Tff7b72true Tff7b72&Tff7b72& Te6edf3isLoraTb4b4b4(Tb4b4b4)

T8b949e/** Returns true if this telemetry packet contains valid, plot-able environment metrics. */

Tff7b72fun Te6edf3TelemetryTb4b4b4.Td2a8ffhasValidEnvironmentMetricsTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657Boolean Tb4b4b4{

Tff7b72val Te6edf3metrics Tff7b72= Tff7b72thisTb4b4b4.Te6edf3environment_metrics Tff7b72?: Tff7b72return Tff7b72false

Tff7b72return Te6edf3metricsTb4b4b4.Te6edf3relative_humidity Tff7b72!Tff7b72= Tff7b72null Tff7b72&Tff7b72& Te6edf3metricsTb4b4b4.Te6edf3temperature Tff7b72!Tff7b72= Tff7b72null Tff7b72&Tff7b72& Tff7b72!Te6edf3metricsTb4b4b4.Te6edf3temperatureTff7b72!!Tb4b4b4.Te6edf3isNaNTb4b4b4(Tb4b4b4)

Tb4b4b4}

T8b949e/**

* Given a human name, strip out the first letter of the first three words and return that as the initials for that

* user, ignoring emojis. If the original name is only one word, strip vowels from the original name and if the result

* is 3 or more characters, use the first three characters. If not, just take the first 3 characters of the original

* name.

*/

Tf0883e@SuppressTb4b4b4(Ta5d6ff"Ta5d6ffMagicNumberTa5d6ff"Tb4b4b4)

Tff7b72fun Td2a8ffgetInitialsTb4b4b4(Te6edf3fullNameTb4b4b4: Tffa657StringTb4b4b4)Tb4b4b4: Tffa657String Tb4b4b4{

Tff7b72val Te6edf3maxInitialLength Tff7b72= T79c0ff4

Tff7b72val Te6edf3minWordCountForInitials Tff7b72= T79c0ff2

Tff7b72val Te6edf3name Tff7b72= Te6edf3fullNameTb4b4b4.Te6edf3trimTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3withoutEmojisTb4b4b4(Tb4b4b4)

Tff7b72val Te6edf3words Tff7b72= Te6edf3nameTb4b4b4.Te6edf3splitTb4b4b4(Te6edf3RegexTb4b4b4(Ta5d6ff"Ta5d6ff\\Ta5d6ffs+Ta5d6ff"Tb4b4b4)Tb4b4b4)Tb4b4b4.Te6edf3filter Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3isNotEmptyTb4b4b4(Tb4b4b4) Tb4b4b4}

Tff7b72val Te6edf3initials Tff7b72=

Tff7b72when Tb4b4b4(Te6edf3wordsTb4b4b4.Te6edf3sizeTb4b4b4) Tb4b4b4{

Tff7b72in T79c0ff0 Te6edf3until Te6edf3minWordCountForInitials Tff7b72-Tff7b72> Tb4b4b4{

Tff7b72val Te6edf3nameWithoutVowels Tff7b72=

Tff7b72if Tb4b4b4(Te6edf3nameTb4b4b4.Te6edf3isNotEmptyTb4b4b4(Tb4b4b4)Tb4b4b4) Tb4b4b4{

Te6edf3nameTb4b4b4.Te6edf3firstTb4b4b4(Tb4b4b4) Tff7b72+ Te6edf3nameTb4b4b4.Te6edf3dropTb4b4b4(T79c0ff1Tb4b4b4)Tb4b4b4.Te6edf3filterNot Tb4b4b4{ Te6edf3c Tff7b72-Tff7b72> Te6edf3cTb4b4b4.Te6edf3lowercaseTb4b4b4(Tb4b4b4) Tff7b72in Ta5d6ff"Ta5d6ffaeiouTa5d6ff" Tb4b4b4}

Tb4b4b4} Tff7b72else Tb4b4b4{

Ta5d6ff"Ta5d6ff"

Tb4b4b4}

Tff7b72if Tb4b4b4(Te6edf3nameWithoutVowelsTb4b4b4.Te6edf3length Tff7b72>Tff7b72= Te6edf3maxInitialLengthTb4b4b4) Te6edf3nameWithoutVowels Tff7b72else Te6edf3name

Tb4b4b4}

Tff7b72else Tff7b72-Tff7b72> Te6edf3wordsTb4b4b4.Te6edf3map Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3firstTb4b4b4(Tb4b4b4) Tb4b4b4}Tb4b4b4.Te6edf3joinToStringTb4b4b4(Ta5d6ff"Ta5d6ff"Tb4b4b4)

Tb4b4b4}

Tff7b72return Te6edf3initialsTb4b4b4.Te6edf3takeTb4b4b4(Te6edf3maxInitialLengthTb4b4b4)

Tb4b4b4}

Tff7b72fun Te6edf3StringTb4b4b4.Td2a8ffwithoutEmojisTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657String Tff7b72= Te6edf3filterNot Tb4b4b4{ Te6edf3char Tff7b72-Tff7b72> Te6edf3charTb4b4b4.Te6edf3isSurrogateTb4b4b4(Tb4b4b4) Tb4b4b4}